home *** CD-ROM | disk | FTP | other *** search
/ LightWavin' Magazine 5 / LightWavin' Magazine, Issue 5 WIN-MAC (DMG Publishing)(1998).iso / mac / Pointfolio / READMEPF.txt < prev   
Text File  |  1997-11-06  |  10KB  |  252 lines
  1.  
  2. --------------------------------------------
  3. README FILE for Pointfolio(Nag) Version 1.00
  4. --------------------------------------------
  5.  
  6.  
  7. =================
  8. Table Of Contents
  9. =================
  10.  
  11.     Description
  12.     Installation
  13.     Dependencies
  14.     Tested On...
  15.     Known Limitations
  16.     Bug Reports
  17.      How to Purchase
  18.  
  19.  
  20.  
  21. -----------
  22. Description
  23. -----------
  24. Pointfolio is a plugin that assists the point selection process
  25. in Lightwave Modeler. It allows one to create arbitrary named
  26. collections of points and build them into larger, more complex
  27. named collections by means of Union, Intersection, and Filter 
  28. operations. Pointfolio is Copyright 1997 by D.J. Hudek.
  29.  
  30. It was motivated by a number of posts to the Lightwave Mailing
  31. List which wished for the ability to select points by arbitrary
  32. groups, other than via associated surface naming.
  33.  
  34.  
  35. After installation, there should be 6 new entries in the Objects/Custom
  36. menu:
  37.     PF_CrModBasic
  38.     PF_CrModCompound
  39.     PF_DeleteAllGroups
  40.     PF_DeleteGroup
  41.     PF_LookupGroup
  42.     PF_SelectGroup
  43.  
  44. These allow the creation, modification, deletion and evaluation of arbitrary
  45. assocations of points with names (hereinafter called point groups) and the
  46. selection of points in a specified point group. Note that a particular point
  47. can be a member of any number of point groups, and that when one speaks of
  48. deleting a point group, only the binding of points to names is deleted --
  49. the points themselves are unaffected.
  50.  
  51. PF_CrModBasic allows one to create a new or modify an existing
  52. association of points with a particular name (a basic point group). 
  53. Names can be up to 80 characters long and include any printable character.
  54. Whatever points are currently selected when PF_CrModBasic is invoked
  55. will then be associated with the specified name.
  56.  
  57. PF_CrModCompound allows one to create a new or modify an existing
  58. association of points with a particular name (a compound point group). 
  59. Names can be up to 80 characters long and include any printable character.
  60. A compound group is specified by supplying a name, an operation, 
  61. and another name. Names can be any already created basic or compound 
  62. point group, as well as a special reserved name ("Prev Selected Points")
  63. which will correspond to whatever points are selected at the time a later
  64. PF_SelectGroup is invoked.
  65.  
  66. The operation can be any one of "Union", "Intersection", or
  67. "Except For". The "union" operation specifies a group of points
  68. consisting of all points in either or both the left hand side name
  69. and the right hand side name. The "intersection" operation specifies
  70. a group of points consisting of all points that are in both
  71. the left hand side and right hand side names. The "except for"
  72. operation specifies a group of points consisting of all points
  73. in the left hand side name that are not in the right hand side name.
  74.  
  75. PF_DeleteAllGroups allows one to delete all point groups at once.
  76.  
  77. PF_DeleteGroup allows one to delete a specified point group.
  78.  
  79. PF_LookupGroup allows one to do multiple look-ups of specified 
  80. point group names. There is a pop-up choice list in which
  81. one chooses the name of interest, and an area to click on that will
  82. update an associated text area in which the contents of the
  83. specified name is given. Looking up a Basic group simply returns
  84. its name. Looking up a Compound group will return the type of the 
  85. left side argument (basic or compound), its name, the operation,
  86. the type of the right side arguement, and its name. One may perform
  87. lookups on multiple names, one at a time, by selecting a name
  88. and then clicking on the to-update area. Clicking on the OK button
  89. dismisses the panel.
  90.  
  91. PF_SelectGroup determines the points that are currently members of the
  92. specified group and then causes them (if present in the foreground layer(s))
  93. to be selected (if particular points no longer exist or exist but are
  94. not in the foreground, they are simply ignored). 
  95. When the operation completes, Modeler will be in point selection mode. 
  96. Basic group points are statically determined at the time they are created. 
  97. Compound group points are dynamically determined after PF_SelectGroup is 
  98. invoked and just prior to the selection process, taking into account any 
  99. changes to any of its dependent groups. 
  100. If it is determined that there are a large number of points to be selected,
  101. a monitor (the "thermometer bar") will be displayed to indicate
  102. the progress and allow the user to abort if desired.
  103.  
  104.  
  105.  
  106.  
  107. ------------
  108. Installation
  109. ------------
  110. If you are reading this, presumably you knew to unzip the downloaded
  111. file  :-)
  112. After unzipping, there should be two new files:
  113.     READMEPF.txt    (this file), and
  114.     PointfolioNag.p (the plugin)
  115.  
  116. Simply move or copy the PointfolioNag.p file to whereever you
  117. keep your Modeler plugins (for example, DRIVE:\newtek\plugins\modeler).
  118. Fire up Modeler and use Objects/Custom/Add Plugin to add
  119. the PoinfolioNag.p plugin. If you do not already have the standard
  120. lwpanels.p added, be sure to do so before first activating Pointfolio.
  121. (If you so desire, you could also have edited the modeler config file
  122. directly, but using the Add Plugin feature is easier and less
  123. prone to typing errors :-) )
  124.  
  125. Once Pointfolio has been added, you should see 6 new menu items
  126. under Objects/Custom, as mentioned above in the description section.
  127.  
  128.  
  129.  
  130. ------------
  131. Dependencies
  132. ------------
  133. lwpanels.p
  134.  
  135. Pointfolio relies on the services provided by the Lwpanels.p plugin.
  136. It must be added to Modeler before this plugin will work.
  137.  
  138.  
  139.  
  140. ------------
  141. Tested On...
  142. ------------
  143. Lightwave 5.0m on an Intel platform
  144.     - Windows NT Workstation 4.0 on a Dual PII system
  145.     - Windows 95 on a Pentium-133
  146. Testing used models of simple to moderate complexity.
  147.  
  148. The version of Lwpanels.p used in testing was dated 6/29/96 and came with
  149. the vanilla lightwave installation (version 5.0m).
  150.  
  151. If the prevailing theory is correct, the Pointfolio plugin should work
  152. with Lightwave version 5.5 as well, but this has not yet been tested
  153. (I only have 5.0 at the moment :-) )
  154.  
  155.  
  156.  
  157.  
  158. -----------------
  159. Known Limitations
  160. -----------------
  161. This wasn't as straightforward as initially hoped; this plugin had to
  162. to dance around the LW SDK in a somewhat convoluted manner. 
  163. This has imposed some limitations. If the SDK changes in the future,
  164. these limitations may be reduced/removed. It is hoped that the plugin
  165. will prove useful despite these limitations.
  166.  
  167.  
  168. If a point group contains thousands of points, it can take
  169. longer than desirable to complete the selection process. A monitor
  170. is provided to show progress and allow a user to abort if desired.
  171.  
  172. At present there is no straightforward way of saving the associations, so
  173. the point naming/grouping exists within a single modelling session only.
  174. When Modeler is finally closed, any point bindings are released.
  175.  
  176. Point IDs used by LW seem to be somewhat transient in nature. This might 
  177. cause problems if a basic point group contains a reference to a point that 
  178. is later cut and one intends to add additional points after that point
  179. deletion. There is a non-zero statistical chance that the same point ID
  180. will be re-used when a new point is later added to the model. If your
  181. modeling tends towards adding/growing/modifying this should not be a problem,
  182. but if it uses a lot of cuts/subtractions, there is a workaround: 
  183. one could use the modify option of the basic group command to update
  184. any groups affected by the point deletion(s) before adding new points 
  185. (e.g., if basic group name XYZ contains a point or points that you 
  186. just deleted, do a PF_SelectGroup of XYZ, follow it up with a PF_CrModBasic
  187. of XYZ and chose the modify option). Note that only the basic groups
  188. need be updated/modified. Compound groups will automatically take up
  189. any modified basic groups.
  190.  
  191. This version of the plugin is intended only for a limited time trial use,
  192. to allow the user to determine if it's helpful or not. If it proves
  193. useful, the user is expected to purchase Pointfolio (see below).
  194. This version has the annoying habit of nagging you about it after
  195. it's been in use for a while (assumption being that if the user is
  196. still using it, it must be of at least some use :-) ).
  197. It also has some artificially limited internal structures that
  198. will limit the number of levels deep in complexity that a compound
  199. name may extend. The purchased version will have neither of these
  200. annoyances.
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207. -----------
  208. Bug Reports
  209. -----------
  210. As my modeling skills are still in the rudimentary stage, the testing
  211. was not as complete as I would have liked. If you'd care to submit
  212. any bug reports, they can be mailed to my aol account: hudeks@aol.com
  213. (the ultranet account is not checked as frequently).
  214.  
  215.  
  216.  
  217.  
  218. ---------------
  219. How to Purchase
  220. ---------------
  221. If you've used this version and don't find it to be useful, sorry,
  222. but thanks for giving it a test drive.  :-)    I may have others in
  223. the future that will prove more satisfactory.
  224.  
  225. If it does prove helpful to you, please register and purchase it.
  226. The purchase price is a modest $20 and may be sent (check or money order)
  227. to the following address:
  228.  
  229.     D.J. Hudek
  230.     17 Bruce St.
  231.     Grafton, MA  01519
  232.  
  233. If you include your email address, a non-nagging version of Pointfolio.p
  234. that allows more complex compound groups to be built up will be sent
  235. in return. I can't imagine that anyone who would use this doesn't have an
  236. email address (???) but if so, we could probably arrange a floppy
  237. mailing for a nominal extra fee (?)
  238.  
  239. Thanks,
  240. d.j.hudek
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.